Skip to content

docs(agent-readiness): add when-to-use guidance and step-by-step agent auth#639

Merged
LinoGiger merged 1 commit into
mainfrom
docs/agent-when-to-use-and-auth-steps
Jun 26, 2026
Merged

docs(agent-readiness): add when-to-use guidance and step-by-step agent auth#639
LinoGiger merged 1 commit into
mainfrom
docs/agent-when-to-use-and-auth-steps

Conversation

@RapidPoseidon

Copy link
Copy Markdown
Contributor

Context

Third pass on orank agent-readiness (now 60/100, grade C, Access at a strong 69/96 after #637 and #638). This PR addresses only the two remaining gaps that are genuinely fixable in this repo — the rest are out of scope by design (see below).

Changes

  • llms.txt — "When to use Rapidata" (Identity gap: no when-to-use guidance). A specific, non-marketing section naming best-fit jobs (model eval, preference/RLHF datasets, annotation, targeted human feedback), what it's not for, and how an agent should call it (SDK / REST / skill).
  • Step-by-step agent auth (Access gap: partial agent auth at /developers, 3/5). An explicit numbered client-credentials flow added to the Authentication page and the /developers portal.

Gaps I deliberately did NOT chase

I'd flag that we're at the point of diminishing returns for honest docs-repo changes:

  • Wikipedia / Wikidata entity (Discovery) — not a codebase change. Self-creating a Wikipedia article violates their conflict-of-interest norms and requires third-party notability first. This is a PR/brand task for the marketing team, not engineering.
  • JSON error responses (Access) — this is backend behaviour (rapidata-backend), not docs. The API already returns structured errors; the scanner can't authenticate, so it hits an HTML 404 on the static docs site. Faking JSON errors on a docs host would be meaningless. Worth raising with the gateway/identity team if the API truly returns HTML on some unauthenticated paths.
  • Developer resource discoverability (Discovery) — external search-engine indexing + third-party signals. We've already pulled every on-site lever (predictable URLs, llms.txt, product-named titles); the remainder is indexing time and earned coverage.

Verification

mkdocs build passes; JSON-LD validated; llms.txt carries the when-to-use section. Takes effect on the next Deploy Documentation run.

🔗 Session: https://session-b4f9bfe9.poseidon.rapidata.internal/

…t auth

Addresses the two remaining gaps that are genuinely fixable in this repo:
- Identity "when-to-use": add a "When to use Rapidata" section to llms.txt naming
  best-fit jobs and how an agent should call it.
- Access agent-auth warning: add an explicit step-by-step client-credentials
  flow to the Authentication page and the /developers portal.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: lino <lino@rapidata.ai>
@claude

claude Bot commented Jun 26, 2026

Copy link
Copy Markdown

Code Review

This PR adds two focused documentation improvements for agent readiness: a "When to use Rapidata" section in llms.txt and a step-by-step agent authentication guide in authentication.md and the developer portal. The intent is solid, but there are a few issues worth addressing before merge.


Findings (most severe first)

1. site_root/developers/index.html — Direct token request missing required fields

The inline step 4 describes the non-SDK token request as:

POST https://auth.rapidata.ai/connect/token with grant_type=client_credentials

This omits client_id, client_secret, and scope. The full example in docs/authentication.md (lines 48–52) shows all three are required:

-d scope="openid email roles"

And the Scopes section explicitly states: "Tokens are scoped. The SDK requests openid roles email by default."

A developer following only the developer portal page will construct an incomplete token request and may receive a token with missing scopes, leading to 403 Forbidden on API calls. Even if there's a "Full details" link at the bottom, this step should at minimum mention that scopes are required, or omit the inline example entirely and just link through.


2. site_root/llms.txt lines 31–33 — Bare cross-references are unresolvable

The new paragraph ends with:

"…use the Python SDK (pip install rapidata, see Quick Start) or the OAuth 2.0 REST API (see Authentication). Coding agents can install the official skill (see AI agents)…"

Every other cross-reference in the file uses a full absolute URL (e.g., line 38: [Quick Start](https://docs.rapidata.ai/latest/quickstart/), line 69: [Use Rapidata from your AI agent](https://docs.rapidata.ai/latest/ai_agents/)). Since llms.txt is specifically designed for LLM consumption, bare "see X" references without URLs are dead ends — a model cannot resolve them. The same three targets already have linked entries elsewhere in the file.

Fix: convert to the same Markdown hyperlink format used throughout, or remove the sentence (the content is already covered with proper links in ## API & AI agents).


3. site_root/llms.txt — New section substantially duplicates existing content

The new ## When to use Rapidata section re-covers ground already stated in the file:

  • Header (line 3): "Rapidata provides human feedback at scale: crowd-sourced labeling, model evaluation, ranking, and preference data (RLHF-style)" — duplicated by all four bullet points in the new section.
  • Line 69: "an official skill that teaches coding agents (Claude Code, Cursor, Copilot, and others) to write Rapidata integrations" — duplicated by the new section's final sentence.
  • Line 73: pip install rapidata — already present in the header (line 8) and the Access section.

The CLAUDE.md rule is: "not repeat information." The new section adds length without adding facts not already present (with better links) elsewhere in the file. Consider consolidating: the "not the right tool for" exclusions are genuinely new and useful, but the rest is redundant.


4. docs/authentication.md — Step 1 of new section duplicates the preceding section

The "## Get credentials" section directly above the new block says:

"Create a client ID and secret under Rapidata Settings → Tokens"

Step 1 of the new section says:

"1. Create a client ID and secret at Rapidata Settings → Tokens"

These are near-verbatim. Step 1 should reference the preceding section rather than repeat the instruction, e.g.: "1. Complete the steps in Get credentials above."


Overall the auth step-by-step is a useful addition and the llms.txt "when not to use" guidance is genuinely new. The main thing to fix before merge is the incomplete token request description in the developer portal.

@LinoGiger LinoGiger merged commit ec0a768 into main Jun 26, 2026
2 checks passed
@LinoGiger LinoGiger deleted the docs/agent-when-to-use-and-auth-steps branch June 26, 2026 14:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants